Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync tests, file paths, metadata, and documentation with the problem-specifications repository #2867

Closed

Conversation

jagdish-15
Copy link
Contributor

@jagdish-15 jagdish-15 commented Nov 17, 2024

Pull Request

This PR addresses the discussion initiated by the maintainer, @kahgoh, in this issue.

This PR aims to synchronize all previously unsynced tests, file paths, metadata, and documentation with the problem-specifications repository.

Proof of Sync

Screenshot 2024-11-17 132930


Reviewer Resources:

Track Policies

Copy link
Member

@kahgoh kahgoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At a glance, I notice there are a number of tests.toml being synced here. I think we should revert the changes to tests.toml sync PR as the exercise's test haven't been updated. Some tracks have an test generator that you can run to re-generate or update the tests, but Java isn't one of them ... so the tests need to be also be updated manually to match.

Alternatively, we could also update the tests as part of this PR. Without looking deeper, I'm not sure how trivial or big of a job updating the tests would be, but I'm happy for you to make the call whether to also update here or later in a separate PR.

@jagdish-15 jagdish-15 force-pushed the sync-with-problem-specification branch from f3b4822 to 0f57713 Compare November 17, 2024 13:25
@jagdish-15
Copy link
Contributor Author

Yes @kahgoh, as mentioned earlier, there were tests.toml files that needed syncing. I wasn’t aware that test files require manual updates, but after your reply, I started manually updating the tests for each exercise. So far, I’ve completed 3 exercises and have 4 more to go. Once I finish, I plan to push changes for all 7 exercises together.

I wanted to clarify if I should add my name to the list of contributors for these exercises. While I’ve manually added tests based on the canonical-data file from the problem-specifications repo, this is more of a sync update. The last time I changed the reference solution and starting point for an exercise, I did add my name. Should I do so here as well?

Regarding the PR structure, I’m considering whether to handle everything in this PR or split it into multiple PRs. Keeping this PR focused on documentation updates and creating separate PRs for the test updates could make the changes more organized and easier to review. Additionally, while the work would remain the same, this approach might better align with contributing guidelines. Let me know your thoughts on the best approach.

@kahgoh
Copy link
Member

kahgoh commented Nov 17, 2024

For the contributors, yes, feel free to add yourself to the contributors list where you've updated the test as you're doing that manually.

For the PR structure, I'd go with splitting as well. In addition to keeping it organized, it also allows the Markdown file updates to go through while we do the test updates.

@jagdish-15
Copy link
Contributor Author

Perfect! That aligns exactly with my thoughts. I'll close this PR altogether and create a single PR for all the documents and separate PRs for the tests of each exercise.

@jagdish-15
Copy link
Contributor Author

I am hereby closing this PR as the other PRs discussed within it have already been raised.

@jagdish-15 jagdish-15 closed this Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants